Release notes

2024r6

Franchises in business API

In this version, the franchise was introduced as an additional content type. Since franchises cannot be

• reated or deleted on the Mediagenix Base platform; or

• linked to contracts or transmissions;

the following APIs have been adapted to follow this behaviour.

When the external reference of a franchise is provided as contentId, an error message is returned.

For example, PUT /contracts call:

{
    "statusCode": "404",
    "message": "The specified resource does not exist.",
    "timestamp": "2024-05-31T18:12:55Z",
    "concept": "Contract",
    "id": "8711961000",
    "errors": [
        {
            "errorCode": "CORE-00004",
            "description": "$_Referenced resource not found",
            "data": [
                "9500899926"
            ]
        }
    ]
}

2024r4

Fix for unclear error messages for POST /contracts call in rights API

1)

Previously, when sending a POST /contracts call that included external references of products that did not exist in WHATS'ON, the error message would not clearly show which product was the issue.

{
  "statusCode": "404",
  "message": "The specified resource does not exist.",
  "timestamp": "2024-02-21T10:29:04Z",
    "concept": "Contract",
    "id": "384724",
    "errors": [
        {
            "errorCode": "CORE-00004",
            "description": "$_Referenced resource not found",
            "data": []
        }
    ]
}

This error message has been improved by including the wrong external reference in the data attribute:

{
    "statusCode": "404",
    "message": "The specified resource does not exist.",
    "timestamp": "2024-05-22T07:16:30Z",
    "concept": "Contract",
    "id": "9294339000",
    "errors": [
        {
            "errorCode": "CORE-00004",
            "description": "$_Referenced resource not found",
            "data": [
                "9294345JUY"
            ]
        }
    ]
}

2)

Additionally, when deleting rights using the POST /contracts call that were already linked to a transmission, the error message would not indicate which right this applied to.

{
    "statusCode": "422",
    "message": "Operation cannot be completed due to violations",
    "timestamp": "2024-05-22T07:29:59Z",
    "concept": "Contract",
    "id": "9294339000",
    "errors": [
        {
            "errorCode": "RIGHTS-00007",
            "description": "$_Exploitation right could not be removed",
            "data": []
        }
    ]
}

From this version, this error message includes more information on the right.

{
    "statusCode": "500",
    "message": "HotLink: Unable to delete Broadcast right (External reference: \"9500865058\" - Linear (All linear and on-demand) - 2) because it is used in [PSITxLink] (Field: Exploitation right).",
    "timestamp": "2024-05-23T06:54:47Z"
}

2024r3

Fix for performance of calls with contractType or contractStatus in rights API

Previously, when

• updating a contract with a lot of rights via the POST or PUT /contracts call; and

• the contractType and contractStatus were included in the body but with the same values as before,

the processing of the call would still take a long time. This was because the contract type already triggered an update of the contract status since they are linked, and then the contract status itself was also updated. This happened for every right in the contract, even if the values had not changed.

This issue has been fixed. If the contractType and contractStatus are included in the call body but their values do not change, no updates will be done, which speeds up the call processing.

2024r2

Clearer error message for unknown companies in rights API

Previously, when

• trying to update a reference to a company on a contract or cost definition using the rights API, for example when updating the distributor or creditor attributes; and

• the provided external reference could not be matched to a company,

an unclear error message was returned only mentioning “$_Referenced resource not found” but no additional information.

This issue has been fixed. In this case, the attribute and external reference are now added to the message in the data tag:

{
    "statusCode": "404",
    "message": "The specified resource does not exist.",
    "timestamp": "2024-02-23T15:05:59Z",
    "concept": "Contract",
    "id": "9310771000",
    "errors": [
        {
            "errorCode": "CORE-00004",
            "description": "$_Referenced resource not found",
            "data": [
                "productionCompany not found: 123456"
            ]
        }
    ]
}

2023r9

Fix for amortizations with more than two decimals in rights API

Using the rights API, it is possible to create cost definitions with amortizations. Previously, creating nominal amortizations per run with values that had more than 2 decimals could result in the following error, even if the sum of the values would be the same as the amount.

  "errors": [
    {
      "errorCode": "RIGHTS-00017",
      "description": "$_The total amount of amortization values cannot be higher than the cost amount",
      "data": []
    }
  ]

This was because the values would be rounded off to two decimals in the database, for example 2820.306819 would be saved as 2820.31, causing inconsistencies.

From this version, when using the POST or PUT /costDefinitions call to create or update amortizations with values that have more than 2 decimals, the following error response will be returned:

{
"statusCode": "422",
"message": "Operation cannot be completed due to violations",
"timestamp": "2023-04-26T14:23:58Z",
"concept": "CostDefinition",
"id": "55555",
"errors": [
{
    "errorCode": "CORE-00002",
    "description": "Maximum 2 decimals are allowed",
    "data": [
        "30.777"
        ]
    }
  ]
}

The YAML of the rights API has been updated for this change.

2023r8

• Additional contract restrictions in rights API

• Start and end times of exploitation windows in rights API

• PUT call to update exchange rates in rights API

• Valid from date in GET /currencies call of rights API

• Fix for linking parent series to contracts in rights API

• Fix for emptying number of runs using PUT or POST /contracts call in rights API

• Fix for number of runs in GET /contracts call of rights API

Additional contract restrictions in rights API

In several calls of the rights API, it is possible to define or retrieve information about exploitation rights and windows.

It was already possible to define blackout, maximum number of runs per unit and free rerun restrictions on those exploitation rights.

From this version, the following restrictions can also be defined:

• Catch-up restriction

• Overlapping episodes restriction

• Manual validation restriction

• Maximum planning period restriction

Consult the WHATS'ON Knowledge Base for more information about these restrictions.

This can be done in the following calls:

• PUT /contracts/{contractId}

• GET /contracts/{contractId}

• POST /contracts

• GET /contracts/{contractId}/contractEntries/{productId}

• POST /contracts/{contractId}/contractEntries/{productId}

• PUT /contracts/{contractId}/contractEntries/{productId}

• GET /exploitationRights/{exploitationRightId}

Catch-up restriction

The catch-up restriction array consists of the following attributes:

• runTypes: This is mandatory. Define the run type that the restriction applies to. This can be run and/or freeRerun.

• runNumbers: Choose the run numbers of linear transmissions that the restriction applies to. This can be one or more individual run numbers and/or the value remainingRuns, which includes run numbers higher than 10 and bundled runs. If this is left empty, it will apply to any run or free rerun.

For example:

      "catchUpRestrictions": [
        {
          "runTypes": [
            "run",
          ],
          "runNumbers": [
            1,
            3,
            "remainingRuns"
          ]
        }
      ]

Overlapping episodes restriction

The restriction array consists of the following attributes:

• fromDate: The start date of the restriction in format YYYY-MM-DD. If it is left empty, it applies from the start date of the right.

• toDate: The end date of the restriction in format YYYY-MM-DD. If it is left empty, it ends on the end date of the right.

• maxNumberOfEpisodes: This is mandatory and defines the maximum number of episodes of the same series that can be planned on an on-demand channel on the same day.

For example:

      "overlappingEpisodesRestrictions": [
        {
          "fromDate": "2019-01-01",
          "toDate": "2019-04-30",
          "maxNumberOfEpisodes": 0
        }
      ]

If it is defined in a POST or PUT call for a contract entry linked to a program or episode, an 422 error code is returned since it can only be created for series:

    "errorCode": "RIGHTS-00037",
    "description": "$_Product with external reference 648257527 must be a series to create an overlapping episode restriction",
     "data": []

Manual validation restriction

The restriction array consists of the following non-mandatory attributes:

• fromDate: The start date of the restriction in format YYYY-MM-DD. If it is left empty, it applies from the start date of the right.

• toDate: The end date of the restriction in format YYYY-MM-DD. If it is left empty, it ends on the end date of the right.

• remarks

For example:

          "manualValidationRestrictions": [
            {
              "fromDate": "2019-01-01",
              "toDate": "2019-04-30",
              "remarks": "COMPLEX CONDITIONS"
            }
          ]

Maximum planning period restriction

The restriction array consists of the following mandatory attributes to define how long an exploitation right is valid after the first run:

• number: Define the number of units.

• unit: Define how the period should be measured. This can be hour, day, week, month, quarter or year.

For example:

          "maximumPlanningPeriodRestrictions": [
            {
              "number": 0,
              "unit": "day"
            }
          ]

The YAML of the rights API has been updated for these changes.

Start and end times of exploitation windows in rights API

In several calls of the rights API, it is possible to define or retrieve information about exploitation rights and windows.

Previously, it was only possible to define or retrieve the start and end dates of the windows.

For example:

 "exploitationWindows": [
        {
        "exploitationWindowId": "209393883",
        "startDateFormula": "string",
        "startDate": "2019-01-01",
        "endDateFormula": "string",
        "endDate": "2019-07-31",
        "remarks": "non-exclusive Spanish SAP",
        ...

However, this meant that the start and end time would always be empty when creating rights from the API.

From this version, it also possible to define and retrieve the start and end times of the windows. The following attributes were added to the exploitationWindows array:

• startTimeFormula

• endTimeFormula: These add a time formula to the window and should contain the abbreviation of the formula you want to use and the offset:

  • Start time of airing (relative): [SA] + 0h

  • End time of airing (relative): [EA] + 0m

  • Sport event: [SE] + 0s

• startTime

• endTime: These add an absolute time to the window and should be in the HH:MM format.

When I define null as value for the attributes, the start and end time of the exploitation window will be emptied.

If both the time and formula attributes are provided, the formulas will take precedence. Therefore, if a time should be defined, the formula attributes should be left out of the call.

For example, in the following case, the window will have Start time of airing (relative) as formula for its start and end time and not 15:30:

    "exploitationWindows": [ 
          { 
          "exploitationWindowId": "209393883",
          "startDateFormula": "string",
          "startDate": "2019-01-01",
          "endDateFormula": "string",
          "endDate": "2019-07-31",
          "startTimeFormula": "[SA] + 0h",
          "startTime": "15:30",
          "endTimeFormula": "[SA] + 0h",
          "endTime": "15:30",
          "remarks": "non-exclusive Spanish SAP",
           ...

These attributes were added in the following calls:

• PUT /contracts/{contractId}

• GET /contracts/{contractId}
• POST /contracts
• GET /contracts/{contractId}/contractEntries/{productId}
• POST /contracts/{contractId}/contractEntries/{productId}
• PUT /contracts/{contractId}/contractEntries/{productId}
• GET /exploitationRights/{exploitationRightId}

The YAML of the rights API has been updated for these changes.

PUT call to update exchange rates in rights API

Previously, it was already possible to retrieve the possible values of the Currency drop-down list using the GET /currencies call of the rights API.

From this version, it also possible to update existing default exchange rates of those currencies using the new PUT /newExchangeRate call with URL. For example: /rights/v1/currencies/{currencyID}/newExchangeRate

The currencyID corresponds to the API reference of the currency for which you want to update the default exchange rate or currency conversion (RN-3104).

The body of the call contains the following mandatory attributes:

{
  "quotation": "1.01",
  "validFrom": "2023-08-01",
  "isDirectQuotation": "Yes"
}

• quotation: The value of the exchange rate with multiple possible decimals.

• validFrom: The date from which the exchange rate should apply in format [yyyy]-[mm]-[dd].

• isDirectQuotation: Indicate whether the direct quotation should be updated (true) or the indirect quotation (false).

  • With the direct quotation, the exchange rate is defined as X local currency = 1 foreign currency. In the site preferences, you can define which quotation should be used by default (RN-3104).

  • The attribute should match the quotation of the site preference. For example, if isDirectQuotation is set to true and Indirect quotation is chosen in the site preferences, the following error is returned:

{
    "statusCode": "422",
    "message": "Operation cannot be completed due to violations",
    "timestamp": "2023-08-07T09:50:57Z",
    "concept": "Exchange rate",
    "id": "JPY",
    "errors": [
        {
            "errorCode": "RIGHTS-00032",
            "description": "$_Quotation type in the payload ('isDirectQuotation': true) is different than in site preferences 'Indirect quotation'",
            "data": [
                "true",
                "Indirect quotation"
            ]
        }
    ]
}

When an exchange rate has already been set on the date entered as validFrom date, the following error is returned:

    "errors": [
        {
            "errorCode": "RIGHTS-00034",
            "description": "The exchange rate has already been set for 2/08/23. \rYou cannot override this.",
            "data": []
        }
    ]

When the exchange rate is correctly updated, the following response is returned with the direct and indirect quotation:

{
    "statusCode": "200",
    "message": "Exchange rate has been modified",
    "timestamp": "2023-08-07T09:55:21Z",
    "concept": "Exchange rate",
    "id": "JPY",
    "exchangeRate": 0.9794319295,
    "reciprocalExchangeRate": 1.0210000000
}

The YAML of the API has been updated for this change.

Valid from date in GET /currencies call of rights API

It was already possible to retrieve the possible values of the Currency drop-down list using the GET /currencies call of the rights API. In a previous version, the current exchange rate value in direct and indirect quotation was already added to the response of the call (See version 2022r8).

From this version, the validFrom date of the current default exchange rate has also been added to the response.

    {
        "id": "GBP",
        "name": "GBP",
        "directQuotation": 1.1538017769,
        "indirectQuotation": 0.8667000000,
        "validFrom": "2022-03-05"
    }

Fix for linking parent series to contracts in rights API

Previously, when you would use a POST /contracts or /contracts/{contractId}/contractEntries/{productId} call and the productId in the body or URL referred to a parent series, the API service would crash and the following error was returned:

{
    "statusCode": "500",
    "message": "This message is not appropriate for this object",
    "timestamp": "2023-05-10T11:32:34Z"
}

This was because parent series cannot be linked to contract entries but the API could not handle this.

This issue has been fixed. From now on, a clearer error message is returned in this case:

{
    "statusCode": "422",
    "message": "Operation cannot be completed due to violations",
    "timestamp": "2023-07-07T08:34:08Z",
    "concept": "ContractEntry",
    "id": null,
    "errors": [
        {
            "errorCode": "RIGHTS-00038",
            "description": "$_Parent series with external reference 671568527 cannot be linked to a contract",
            "data": [
                "671568527"
            ]
        }
    ]
}

Fix for emptying number of runs using PUT or POST /contracts call in rights API

Previously, when

• an exploitation right existed with 2 runs and 2 free reruns which were all linked to transmissions,

• and a PUT or POST /contracts call was sent with a body that sets the number of runs to null, for example:

{
    "contractId": "640530000",
     ...
    "contractEntries": [
        {
            "productId": "145978527",
            "episodeIds": [
                "145994527"
            ],
            "exploitationRights": [
                {
                    "exploitationRightId": "673459005",
                    "productId": "145978527",
                    "episodeIds": [
                        "145994527"
                    ],
                    "exploitationRightType": "Free TV",
                    "status": null,
                    "numberOfRuns": {
                        "value": null,
                        "numberOfRunsCountType": "Count"
                    }
                   ...

the BAPI service would crash and return the following error:

{
    "statusCode": "500",
    "message": "Message not understood: #differenceFromSmallInteger:",
    "timestamp": "2023-05-10T17:37:00Z"
}

This was because the External number of runs field (RN-5109) is a formula field, which is not allowed to be empty.

This issue has been fixed. From now on, a 422 error message is returned:

{
    "statusCode": "422",
    "message": "Operation cannot be completed due to violations",
    "timestamp": "2023-05-12T13:41:10Z",
    "concept": "Contract",
    "id": "640530000",
    "errors": [
        {
            "errorCode": "CORE-00002",
            "description": "value cannot be null",
            "data": []
        }
    ]
}

Fix for number of runs in GET /contracts call of rights API

In a previous version, the External number of runs and External number of free reruns were introduced to allow an external right system to update the number of runs or free reruns using the BAPI, even if there is a run or free rerun linked to a transmission with a lower run number, which would require runs to be unlinked from the planning.

However, when

• an exploitation right existed with runs and free reruns which were all linked to transmissions (for example, 2 runs and 2 free reruns);

• a PUT /contracts call was sent that updated the number of runs and number of free reruns to 0;

• and a GET /contracts call was done to retrieve details of the contract,

the numberOfRuns would be 2, which was incorrect. When the actual number of runs cannot be lowered, the External number of runs is set to 0 instead. In the GET /contracts call, the value of the external number of runs should then be returned (RN-5109). However, until now, for the numberOfRuns, the External number of runs would not be returned when it was empty or 0.

This issue has been fixed. In the GET /contracts call, the numberOfRuns will have the value of the External number of runs unless it is empty, then the Number of runs is returned.

2023r7

Generated contract numbers in rights API and model-based importer

It is now possible to automatically generate contract numbers. (RN-5713) Because the contract number is used in the rights API, the following calls have been adapted.

POST /contracts

If the contract number generation is set to Automatic,

• and a contract number is provided in the payload (with value or null), a 422 error is returned:

   "errorCode": "RIGHTS-00038",
   "description": "The contract number cannot be changed as it is generated automatically.",
   "data": []

• and the contract number is not provided, then WHATS'ON will create the contract with a generated number.

If the contract number generation is set to Manual,

• and the contract number is missing in the payload or provided with a null value, then a 422 error is returned as the contract number is mandatory;

            "errorCode": "872",
            "description": "Please enter the field Contract number.",
            "data": [
                "Contract number"

• and a contract number is provided, then the contract is created with that number.

PUT /contract

If the contract number generation is set to Automatic,

• and a contract number is provided in the payload (with value or null), a 422 error is returned:

      "errorCode": "RIGHTS-00038"   
      "description": "The contract number cannot be changed as it is generated automatically.",
      "data": []

• and the contract number is not provided, then it is left as it is.

If the contract number generation is set to Manual,

• and the contract number is missing in the payload, the call is accepted.

• and the contract number is provided with a null value, then a 422 error is returned as the contract number is mandatory;

     "errorCode": "872",
      "description": "Please enter the field Contract number.",
      "data": [
            "Contract number"

• and a contract number is provided, then the contract is updated with that number.

Provisional dates in rights API

With the addition of the provisional dates on exploitation rights (RN-5680), the following attributes have been added to the GET /exploitationRights/{exploitationRightId} call of the rights API:

• Provisional start date

• Provisional start date

• Start date accuracy

• End date accuracy

When these fields have been entered on the window of the provided exploitation right, they are returned in the response body of the call.

For example:

     "provisionalStartDate": "2023-08-01",
     "provisionalEndDate": "2024-07-31",
     "startDateAccuracy": "Exact",
     "endDateAccuracy": "Exact"

A new version of the YAML is needed to be able to see these attributes.

2023r6

Fix for update run service records, available rights service and rights API service

Previously, update run service records were linked to broadcast right groups. When these broadcast right groups were removed, any linked records were also removed. This caused issues between the update run service and services that remove broadcast right groups at the same time, as service records were sometimes deleted at the same time.

This issue has been fixed. The hard link between the broadcast right group and the update run service records has been removed. Now, the records only have a reference to the OID of the broadcast right group, which ensures that the update run service records are not deleted when a broadcast right group is removed.

Furthermore, in certain cases, the rights API encountered multi-user errors, resulting in a "statusCode : 500" error with the message indicating: "Trying to delete 10 rows but deleted 0 instead."

The root cause was a conflict between the available rights service and the BAPI service, both of which attempted to remove broadcast right groups simultaneously, resulting in a conflict.

A fix was implemented to prevent the available rights service and the BAPI service from removing broadcast right groups simultaneously.

2022r11

Fix for message in BAPI service when using PUT /contractEntries call on manually linked bundled run

Previously, when

• manually linking a bundled run to transmission, for example 1-3;

• setting the site preference Minimal number of runs to be taken from the bundle automatically upon exploitation right creation to that same number, so for example 3;

• and updating the contract entry of the right using the PUT /contractEntries call and a body that increases the number of runs,

a message log appeared in the BAPI service and the following response would be returned:

{
    "statusCode": "422",
    "message": "Operation cannot be completed due to violations",
    "timestamp": "2022-12-16T11:50:10Z",
    "concept": "ContractEntry",
    "id": null,
    "errors": null
}

This issue has been fixed. The following response is now returned in this scenario instead of appearing in the service:

{
    "statusCode": "422",
    "message": "Operation cannot be completed due to violations",
    "timestamp": "2022-12-16T11:56:57Z",
    "concept": "ContractEntry",
    "id": null,
    "errors": [
        {
            "errorCode": "RIGHTS-00311",
            "description": "This run cannot be taken from the bundle because it is manually linked: Luce - Run, 1 - 4",
            "data": [
                "Luce - Run, 1 - 4"
            ]
        }
    ]
}

2022r10

Fix for updating external number of runs or free reruns using /contracts calls of rights API

In a previous version, an external number of runs and free reruns was introduced to be able to update run or free rerun numbers to a lower number than used in the schedule. (RN-5109) This could be done using the /contract or /contractEntries calls of the rights API.

Previously, however, the POST and PUT /contract calls still returned the following error when trying to make the number of runs or free reruns lower and a run was already linked:

{
   "statusCode": "422", 
   "message": "Operation cannot be completed due to violations",
   "timestamp": "2022-08-22T13:45:14Z",
   "concept": "Contract",
   "id": "CN 12345",
   "errors": [
        "This run cannot be deleted: Big - Run, 1 - 1"
   ]
}

This issue has been fixed. Both the /contract or /contractEntries calls will update as expected.

2022r8

Direct and indirect quotation in GET /currency call of rights API

It was already possible to use the GET /currencies call of the rights API to retrieve all possible values of the Currency drop-down list.

From this version, the response will also include the values of the direct and indirect quotation of the default conversion for each currency, as they are defined on the drop-down list:

[
    {
        "id": "EUR",
        "name": "Euro",
        "directQuotation": 1,
        "indirectQuotation": 1
    },
    {
        "id": "GBP",
        "name": "GBP",
        "directQuotation": 1.1538017769,
        "indirectQuotation": 0.8667000000
    }
]

2022r7

Free rerun period units in rights API

When defining the free rerun period on rights, several units are available:

• Broadcast day

• Day starting at same time as run

• Hour

• Calendar day

The unit Day starting at same time as run used to be called Calendar day but was renamed in a previous version. (RN-2098)

In version 2021r2.001, the unit Calendar day was added (RN-4459), but it was not yet part of the rights API.

From this version, it has been added to the possible units of the rights API.

The FreeRerunPeriod attribute is used in the following calls:

• POST /contracts/{contractId}

• PUT /contracts/{contractId}

• GET /contracts/{contractId}

• POST contracts/{contractId}/contractEntries/{productId}

• PUT contracts/{contractId}/contractEntries/{productId}

• GET contracts/{contractId}/contractEntries/{productId}

• GET exploitationRights/{exploitationRightId}

Fix for same financial stock partition in PUT /costDefinitions call of rights API

Previously, when

• you would send a GET /costDefinitions call with the rights API to retrieve the details of a cost definition;

• and you would send that response body in a PUT /costDefinitions call without changing it,

then an error would be returned saying that the financial stock partition could not be modified, even though it had not changed.

This issue has been fixed. If the stock partition does not change, the call will be accepted.

2021r3.000

BAPI call for exploitation right

From this version, in the rights API, a new GET /exploitationRights/exploitationRightId call has been added. The call contains the same exploitation right information as you can find already today in the GET /contractEntries call, but also the contractId is returned.

The difference between the response bodies of GET calls /contracts/{contractId}/contractEntries/{productId} and /exploitationRights/{exploitationRightId} is that the GET /contractEntries call also returns the attribute additionalRights.

2019r3.003

API version: v1.4.0

Cost definitions and amortizations

From this version on, it is possible to work with cost definitions and their amortizations via new calls in the rights API.

Run status

From this version on, it is also possible to change the status of runs via new calls in the rights API.

More detailed error messages

Several improvements were done to return more specific error message in case of problems during a call.

Episode ID referring to other product type

When you update a series contract entry using the POST or PUT calls for contracts or contract entries, and one of the provided episodeIDs does not refer to an episode but a different product type, previously, the returned error message only said:

{

    "statusCode": "500",

    "message": "Message not understood: #,"

} 

Now, the error message indicates the specific problem:

{
    "statusCode": "422",
    "message": "Operation cannot be completed due to violations",
    "details": {
        "message": {
            "id": "CORE-00002",
            "description": "$_Operation cannot be completed due to violations",
            "parameters": []
        },
        "timestamp": "2021-04-23T07:14:33Z",
        "concept": "ContractEntry",
        "message": "INCONSISTENT FIELD - episodeIds",
        "data": "142205527 is not an episode"
    }
} 

Deleting a planned contract entry

When you update a contract using the POST or PUT calls, and a contract entry was left out while runs were already consumed, this meant the contract entry could not be removed. Previously, the returned error message only said:

{
       "statusCode": "422",
       "message": null,
       "details":
       {
              "message":
              {
                     "id": "RIGHTS-00001",
                     "description": "$_ContractEntry could not be removed",
                     "parameters": [
                     ]
              },
              "concept": "Contract"
       }

Now, the error message indicates the specific contract entry:

{
    "statusCode": "422",
    "message": null,
    "details": {
        "message": {
            "id": "RIGHTS-00001",
            "description": "$_ContractEntry could not be removed",
            "parameters": [
                "[Kine2] Knives Out (Disney)"
            ]
        },
        "concept": "Contract"
    }
}

Invalid episode ID

When you update a series contract entry using the POST or PUT calls for contracts or contract entries, and one of the provided episodeIDs is not correct, previously, the returned error message only said:

{
    "statusCode": "404",
    "message": "The specified resource does not exist.",
    "details": {
        "message": {
            "id": "CORE-00004",
            "description": "$_Referenced resource not found",
            "parameters": []
        },
        "concept": "ContractEntry"
    }
}

Now, the error message indicates which IDs are invalid in the parameters:

{
    "statusCode": "404",
    "message": "The specified resource does not exist.",
    "details": {
        "message": {
            "id": "CORE-00004",
            "description": "$_Referenced resource not found",
            "parameters": [
                "B357556527",
                "B357570527"
            ]
        },
        "concept": "Contract"
    }
}

2020r1.002.000

API version: v1.4.0

External reference cannot be cleared by BAPI

Within any POST and PUT call, if a an attribute is sent empty, WHATS'ON will clear that field. Previously, this was also possible with the external reference of a contract, exploitation right, exploitation window or cost definition.

Now, this is fixed. When no external reference is provided but the attribute is sent empty or null, we will ignore that tag and proceed as if there was no ID field (external reference) provided. This means that it should remain as is in a PUT call or return a new one in a POST call.